Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MJARSIGNER-62] Enhanced documentation for usage of arguments #17

Merged
merged 1 commit into from
Dec 11, 2023

Conversation

schedin
Copy link
Contributor

@schedin schedin commented Dec 10, 2023

The author of https://issues.apache.org/jira/projects/MJARSIGNER/issues/MJARSIGNER-62 would like to use a 2-element additional argument to the jarsigner command line. The author believes that the problem they are having is that maven-jarsigner-plugin (on top of the https://github.com/apache/maven-jarsigner project) is quoting the arguments, and that is causing the problem.

I believe that the author is not correct: it is how the arguments were used by the author that is the problem. But I still think that the author has a good point. I my opinion the arguments parameter is not properly documented. You must be experienced with Maven to understand how to use it. I have used Maven for many years, and I still have problems with this. This pull request improves the documentation, so it is understandable for even a novice Maven user. When this pull request is accepted, I think that MJARSIGNER-62 can be closed.

As an example, the -certchain is used in the ticket description. For this specific parameter there already exists a dedicated parameter. If/when #14 is accepted this will also have a correct documentation on https://maven.apache.org/plugins/maven-jarsigner-plugin/sign-mojo.html

As an example, in this pull request, I have selected a parameter that maven-jarsigner-plugin does not have support for: -signedjar file. This is a good parameter as an example because I don’t think maven-jarsigner-plugin will implement support for this (since maven-jarsigner-plugin is used to sign many jarfiles, it does not make sense to overwrite every jar into a single output jarfile).

Example of rendered output:
image

Copy link
Contributor

@elharo elharo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

@elharo elharo merged commit 7e47f46 into apache:master Dec 11, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants